docs(refid): add ID pattern catalog - #185
Open
sthanikan2000 wants to merge 1 commit into
Open
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Team Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Catalogs the shapes producible from refid's segment grammar (literal, list, date, sequence) and sequence reset cadences, with a runnable example config per shape, and links it from the README.
sthanikan2000
force-pushed
the
docs/refid-id-pattern-catalog
branch
from
September 4, 2026 07:36
a36c129 to
233ed29
Compare
ginaxu1
approved these changes
Sep 8, 2026
ginaxu1
left a comment
ginaxu1
left a comment
Contributor
There was a problem hiding this comment.
non-blocking nits:
- Example IDs use
000042. 1st call is000001. Same convention as the existing README; a one-liner would make that obvious - Line-number links will rot.
registry.go:173–187is accurate today; a later edit will silently point at the wrong function. Symbol names are more durable.
3.*Section 2 slightly overstates "placeholders only" Isolation is the fully resolved scope-key string. P8’s:primary/:secondarysuffixes also split counters - Shared
scopeKeyon two sequences does more than "share one counter": oneGenerateconsumes two increments (A-000001-000002). Worth one sentence in P8. - Visible ID and reset cadence are independent. You can put a daily date in the ID and a never-resetting sequence (or the reverse). The catalog couples them in examples but never says that mismatch is legal and easy to misconfigure.
- "Reset" is a new
scope_keyrow, not truncation of the old counter. Matches existing README language, so not a new inaccuracy
lokewate
approved these changes
Sep 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
refid/docs/PATTERNS.md, cataloging the ID shapes producible from refid's segment grammar (literal,list,date,sequence) and the sequence reset-cadence dimensions, each backed by a runnable exampleConfig.refid/README.mdright after the Scope Key Placeholders section.Test plan
go test -race ./...passed (via pre-push hook)